kone.collections/dev.lounres.kone.collections.list

Package-level declarations

Types

KoneGrowableMutableList

@Serializable(with = DefaultKoneGrowableMutableListSerializer::class)

interface KoneGrowableMutableList<Element> : KoneMutableList<Element>

Represents a KoneMutableList which inner structure has a capacity that can be increased.

KoneGrowableMutableNoddedList

@Serializable(with = DefaultKoneGrowableMutableNoddedListSerializer::class)

interface KoneGrowableMutableNoddedList<Element> : KoneMutableNoddedList<Element> , KoneGrowableMutableList<Element>

Represents a nodded version of KoneGrowableMutableList. See KoneNoddedList for more.

KoneList

@Serializable(with = DefaultKoneListSerializer::class)

interface KoneList<out Element> : KoneLinearIterable<Element>

Represents a finite collection of elements with some order on them.

KoneListIterator

typealias KoneListIterator<Element> = KoneLinearIterator<Element>

Represents iterator over KoneList with iteration order coincident with the list elements order. See KoneLinearIterator for more.

KoneListNode

interface KoneListNode<out Element>

Represents a node in the inner structure of a KoneNoddedList. See KoneNoddedList and KoneList for more.

KoneMutableList

@Serializable(with = DefaultKoneMutableListSerializer::class)

interface KoneMutableList<Element> : KoneSettableList<Element> , KoneMutableLinearIterable<Element>

Represents a finite collection of elements with some order on them with possibility to add, replace, and replace element at the provided index.

KoneMutableListIterator

typealias KoneMutableListIterator<Element> = KoneMutableLinearIterator<Element>

Represents iterator over KoneMutableList with iteration order coincident with the list elements order. See KoneMutableLinearIterator for more.

KoneMutableListNode

interface KoneMutableListNode<Element> : KoneSettableListNode<Element>

Represents a node in the inner structure of a KoneMutableNoddedList. See KoneMutableNoddedList and KoneMutableList for more.

KoneMutableNoddedList

@Serializable(with = DefaultKoneMutableNoddedListSerializer::class)

interface KoneMutableNoddedList<Element> : KoneSettableNoddedList<Element> , KoneMutableList<Element>

Represents a nodded version of KoneMutableList. See KoneNoddedList for more.

KoneMutableNoddedListIterator

interface KoneMutableNoddedListIterator<Element> : KoneSettableNoddedListIterator<Element> , KoneMutableLinearIterator<Element>

Represents iterator over KoneMutableNoddedList.

KoneNoddedList

@Serializable(with = DefaultKoneNoddedListSerializer::class)

interface KoneNoddedList<out Element> : KoneList<Element>

Represents a nodded version of KoneList.

KoneNoddedListIterator

interface KoneNoddedListIterator<out Element> : KoneLinearIterator<Element>

Represents iterator over KoneNoddedList.

KoneSettableList

@Serializable(with = DefaultKoneSettableListSerializer::class)

interface KoneSettableList<Element> : KoneList<Element> , KoneSettableLinearIterable<Element>

Represents a finite collection of elements with some order on them with possibility to replace element at the provided index.

KoneSettableListIterator

typealias KoneSettableListIterator<Element> = KoneSettableLinearIterator<Element>

Represents iterator over KoneSettableList with iteration order coincident with the list elements order. See KoneSettableLinearIterator for more.

KoneSettableListNode

interface KoneSettableListNode<Element> : KoneListNode<Element>

Represents a node in the inner structure of a KoneSettableNoddedList. See KoneSettableNoddedList and KoneSettableList for more.

KoneSettableNoddedList

@Serializable(with = DefaultKoneSettableNoddedListSerializer::class)

interface KoneSettableNoddedList<Element> : KoneNoddedList<Element> , KoneSettableList<Element>

Represents a nodded version of KoneSettableList. See KoneNoddedList for more.

KoneSettableNoddedListIterator

interface KoneSettableNoddedListIterator<Element> : KoneNoddedListIterator<Element> , KoneSettableLinearIterator<Element>

Represents iterator over KoneSettableNoddedList.

Properties

indices

val KoneList<*>.indices: UIntRange

Returns the list's indices range.

lastIndex

val KoneList<*>.lastIndex: UInt

Returns the last index of elements in the list.

Functions

addAllFrom

fun <Element> KoneMutableList<Element>.addAllFrom(elements: KoneIterable<Element>)

Adds provided elements at the end of the ordered collection.

addAllFromAt

fun <Element> KoneMutableList<Element>.addAllFromAt(index: UInt, elements: KoneIterable<Element>)

Adds provided elements before element with index index.

buildKoneList

inline fun <Element> buildKoneList(builderAction: KoneMutableList<Element>.() -> Unit): KoneList<Element>

inline fun <Element> buildKoneList(initialCapacity: UInt, builderAction: KoneMutableList<Element>.() -> Unit): KoneList<Element>

emptyKoneList

fun <Element> emptyKoneList(): KoneList<Element>

Returns empty list.

getMaybe

fun <Element> KoneList<Element>.getMaybe(index: UInt): Maybe<Element>

Returns the element at the provided index wrapped in Some or None if index is out of bounds.

getOrElse

fun <Element> KoneList<Element>.getOrElse(index: UInt, block: () -> Element): Element

getOrNull

fun <Element> KoneList<Element>.getOrNull(index: UInt): Element?

Returns the element at the provided index or null if index is out of bounds.

KoneList

inline fun <Element> KoneList(size: UInt, initializer: (index: UInt) -> Element): KoneList<Element>

Returns a list of provided size of elements produced by the initializer.

koneListOf

fun <Element> koneListOf(): KoneList<Element>

fun <Element> koneListOf(element: Element): KoneList<Element>

fun <Element> koneListOf(vararg elements: Element): KoneList<Element>

KoneMutableList

inline fun <Element> KoneMutableList(size: UInt, initializer: (index: UInt) -> Element): KoneMutableList<Element>

Returns a mutable list of provided size of elements produced by the initializer.

koneMutableListOf

fun <Element> koneMutableListOf(): KoneMutableList<Element>

fun <Element> koneMutableListOf(vararg elements: Element): KoneMutableList<Element>

KoneSettableList

inline fun <Element> KoneSettableList(size: UInt, initializer: (index: UInt) -> Element): KoneSettableList<Element>

Returns a settable list of provided size of elements produced by the initializer.

koneSettableListOf

fun <Element> koneSettableListOf(vararg elements: Element): KoneSettableList<Element>

remove

fun <Element> KoneMutableList<Element>.remove(element: Element)

retainAllThat

inline fun <Element> KoneMutableList<Element>.retainAllThat(crossinline predicate: (element: Element) -> Boolean)

Iterates over the collection and retains only the elements matching the predicate.

retainAllThatIndexed

inline fun <Element> KoneMutableList<Element>.retainAllThatIndexed(crossinline predicate: (index: UInt, element: Element) -> Boolean)

Iterates over the collection and retains only the elements matching the predicate.

toKoneList

fun <Element> KoneIterable<Element>.toKoneList(): KoneList<Element>

toKoneMutableList

fun <Element> KoneIterable<Element>.toKoneMutableList(): KoneMutableList<Element>

toKoneSettableList

fun <Element> KoneIterable<Element>.toKoneSettableList(): KoneSettableList<Element>